/****************************************************************************
 * Copyright 2010 Huascar A. Sanchez                                        *
 *                                                                          *
 * Licensed under the Apache License, Version 2.0 (the "License");          *
 * you may not use this file except in compliance with the License.         *
 * You may obtain a copy of the License at                                  *
 *                                                                          *
 *     http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                          *
 * Unless required by applicable law or agreed to in writing, software      *
 * distributed under the License is distributed on an "AS IS" BASIS,        *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 * See the License for the specific language governing permissions and      *
 * limitations under the License.                                           *
 ****************************************************************************/
package com.gotobject.filter.spi;

/**
 * worked on single objects before/after they are filtered out.
 * @author huascar.sanchez@gmail.com (Huascar A. Sanchez)
 */
public interface Function<F, T> {
    /**
     * applies the function to an object of type {@code F}, resulting in an object
     * of type {@code T}.  Note that types {@code F} and {@code T} may or may not
     * be the same.
     *
     * @param from the source object
     * @return the resulting object
     * @throws Exception
     *      unable to apply the function.
     */    
    T apply(F from) throws Exception;
}
